home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / database / dates707.zip / DATES.DOC < prev    next >
Text File  |  1997-07-31  |  31KB  |  684 lines
  1. DATES.DOC                              1                           Jul 31, 1997
  2.  
  3. This program keeps track of  birthdays,  anniversaries,  upcoming  events,  etc
  4. giving you advance warning so you can send out cards, leave town, etc. Features
  5. of this program:
  6.  
  7.   * Initially defaults to showing all events happening within 14 days.
  8.   * You can set up multiple date files, each with their own day threshold;  for
  9.     example, one file for birthdays, another for business meetings, etc.
  10.   * You can establish a different  threshold  on  an  event-by-event  basis  if
  11.     desired.
  12.   * This program can be included in your AUTOEXEC.BAT file to  provide  notices
  13.     every time you turn on your PC.
  14.   * You can specify dates like the "last Thursday" or the "first Monday"  of  a
  15.     given month.
  16.   * Month-long dates can be entered (e.g. "10/XX/XX Customer Service Month").
  17.   * Recurring dates that happen each month on the  same  date  (e.g.  "XX/14/XX
  18.     Mortgage due") can be used.
  19.   * Weekly reminders for events that happen the same weekday every week can  be
  20.     used.
  21.   * Dates can be in the United States format (/DATE=mm/dd/yy) or in most  other
  22.     formats (for example, /DATE=dd-mm-yy).
  23.   * The output date format does not have to match the input date format.
  24.   * Months can be entered as sequential months (1 for January, 2 for  February,
  25.     etc) or else entered as the months themselves (JAN, FEB, etc).
  26.   * Dates don't have to be padded (9/6/94, 09/06/94, and  SEP/06/1994  are  all
  27.     accepted).
  28.   * Dates in the future can be processed or ignored at your preference.
  29.   * The program will show you the weekday, age, and/or days until the event  if
  30.     desired.
  31.   * Comment lines can be displayed (e.g. "Events relating to work:").
  32.   * The program can automatically pause when done or  after  a  set  number  of
  33.     lines if desired.
  34.   * Entries can be sorted before display based on their "date difference"  (the
  35.     number of days before the event occurs) or in their original order.
  36.   * Decimal codes (like CR/LF) can be embedded in the display file if  desired,
  37.     allowing you to change colors with in the display line or  split  the  line
  38.     into several lines for display.
  39.   * Pressing escape stops the program early.
  40.  
  41.  
  42. DATES.DOC                              2                           Jul 31, 1997
  43.  
  44. Quickie instructions:
  45.  
  46.   Okay!  You hate to read.  I know that.  And there aren't any cute pictures in
  47.   this documentation and, like everything I write, it's way too  long  to  keep
  48.   your attention for long.  So, let's bottom line it; what's the  quickest  way
  49.   to use this program without learning any of the options?
  50.  
  51.   Take the DATES.EXE and DATES.TXT files from the DATESymm.ZIP  file  and  copy
  52.   them to the same  subdirectory  somewhere.   (They  should  be  in  the  same
  53.   subdirectory already since that's how uncompressing them would have gone.)
  54.  
  55.   Now, just run DATES.EXE.
  56.  
  57.   If nothing showed up, there probably weren't any dates  in  the  sample  file
  58.   that were going to show up in the next 2 weeks (the initial default).  Hop to
  59.   DOS. Change your default subdirectory to be the  location  where  you  copied
  60.   DATES.EXE and DATES.TXT (for example, "CD \TEMP").  Now,  type  "DATES  /D60"
  61.   and press ENTER.  That should find something.
  62.  
  63.   Cute.  Now, edit the DATES.TXT file using NotePad or EDIT or something.  Look
  64.   at the sample lines in that file and add any dates you  want  to  add.   (All
  65.   dates are in mm/dd/yy format.  If you want to change  this,  you'll  have  to
  66.   change all of them and pass in a /DATE=format specification.) Make  sure  you
  67.   save the file as an ASCII text file.
  68.  
  69.   Run DATES again.
  70.  
  71.   Entries didn't show up in date order and you wanted them in that  order?   No
  72.   problem.  Just say "DATES /SORT".
  73.  
  74.   Type in "DATES /?" and try out some of the other  parameters.   If  you  find
  75.   yourself consistently overriding some  of  them,  they  can  be  saved  in  a
  76.   DATES.INI file.  Read the BRUCEINI.DOC file for  information  on  how  to  do
  77.   this.
  78.  
  79.  
  80. The dates input file:
  81.  
  82.   The dates file is a simple ASCII text file, created and maintained  with  any
  83.   text editor.  Each record should begin with a  date  (typically  in  mm/dd/yy
  84.   format) followed by a description of the event.  For example:
  85.  
  86.         05/05/93 Lucy Baines
  87.  
  88.   Blank lines or any line which begins with a colon (":") or  semi-colon  (";")
  89.   are ignored by the program.  Lines which begin with  an  asterisk  ("*")  are
  90.   printed verbatim (minus the asterisk); add spacing after the asterisk if  you
  91.   want the lines to be indented upon display.  Note:  Comments will be  ignored
  92.   if /SORT is specified.
  93.  
  94.  
  95. DATES.DOC                              3                           Jul 31, 1997
  96.  
  97. The format for the date:
  98.  
  99.   Note that the format for the dates shown in the input file is not necessarily
  100.   the same as the format shown on display.  See the /ODATE=format parameter for
  101.   output formats.
  102.  
  103.   For the date portion of the record, you have some flexibility.   By  default,
  104.   the program expects dates to be in a mm/dd/yy format.  So August 5,  1993  is
  105.   "08/05/93".  Even with the "mm/dd/yy" format, however, four-digit  years  can
  106.   be entered if desired (for example, "06/05/2005").
  107.  
  108.   You can change the sequence  of  the  numbers  by  using  the  "/DATE=format"
  109.   option. For example, you can  specify  "/DATE=dd-mm-yy"  if  you  want.   The
  110.   format must consist of the characters "DD",  "MM,  "YY",  and  one  delimiter
  111.   character.  The "DD", "MM", and "YY" characters can be in either uppercase or
  112.   lowercase letters.
  113.  
  114.   The date delimiter has to be either a dash  ("-"),  slash  ("/"),  or  period
  115.   (".").
  116.  
  117.   Examples of /DATE=format specifications might be any of the following:
  118.  
  119.         /DATE=mm/dd/yy      (which is the default)
  120.         /DATE=dd.mm.yy
  121.         /DATE=mm-dd-yy
  122.  
  123.   The routine parses the date field based on the delimiters and  accept  fields
  124.   with or without padding, years with or without the  century,  and  alphabetic
  125.   months instead of just numeric ones.  For example, using /DATE=dd.mm.yy,  all
  126.   of the following September 5, 1994 events are the same:
  127.  
  128.         05.09.94 Big event
  129.         5.9.94 Same event
  130.         5.sep.1994 Still the same thing
  131.         05.september.1994 And yet again the same event
  132.  
  133. Relative weekdays:
  134.  
  135.   If you want, you can specify a day of the month based on a  relative  weekday
  136.   within the month.  For example, in the United States, Thanksgiving  falls  on
  137.   the last Thursday in November and Father's Day is the third Sunday in June.
  138.  
  139.   If it's a relative weekday from the beginning of the month, DATES allows  you
  140.   to enter these in the "day" field by using  "nww"  where  "n"  indicates  the
  141.   sequence of the weekday (if you leave it off, it's presumed to be the  first)
  142.   and "ww" is the first two letters of the day.  If  it's  a  relative  weekday
  143.   from the end of the month, use "Lnww" ("n" defaults to 1).
  144.  
  145.   The weekdays themselves are entered as "SU", "MO", "TU",  "WE",  "TH",  "FR",
  146.   and "SA".
  147.  
  148.   So, for these two examples, they can be entered in your file as:
  149.  
  150.         11/LTH/XX Thanksgiving
  151.         06/3SU/XX Father's Day
  152.  
  153.  
  154. DATES.DOC                              4                           Jul 31, 1997
  155.  
  156. Weekly reminders:
  157.  
  158.   The program can be used to display weekly reminders, which  happen  the  same
  159.   day every week.  This is entered like this:
  160.  
  161.         xx/FR/xx It's Friday!
  162.  
  163.   In this case, the program will show you the first instance of  the  event  no
  164.   matter what your /Ddays parameter is.  If you want  the  event  to  be  shown
  165.   multiple times based on your  /Ddays  parameter,  enter  5  relative  weekday
  166.   requests instead:
  167.  
  168.         xx/1FR/xx It's Friday (showing in advance)
  169.         xx/2FR/xx It's Friday (showing in advance)
  170.         xx/3FR/xx It's Friday (showing in advance)
  171.         xx/4FR/xx It's Friday (showing in advance)
  172.         xx/5FR/xx It's Friday (showing in advance)
  173.  
  174. Dummy month, day, year parameters:
  175.  
  176.   The month, day, and year portions can be "xx" if desired.   (Obviously,  they
  177.   can't be all provided as such.)
  178.  
  179.   If a day is "xx", you will be given the notice for the entire month  and  for
  180.   15 days before the start of the month.  For dates which  vary  from  year  to
  181.   year and which can't be done using something like "LTH" or  "2MO"  (primarily
  182.   Easter) you can either use the "xx" option for the day  or  revise  the  file
  183.   every year.
  184.  
  185.   If a month is "XX", the date is presumed to recur each month.   For  example,
  186.   "XX/10/XX Mortgage due" or "XX/3TH/XX Monthly Alanon meeting".
  187.  
  188. Which dates will show up (the /Ddays parameter):
  189.  
  190.   There's a default age threshold which determines what entries in  your  dates
  191.   file(s) will show up.  (Using multiple dates files--each with their own  date
  192.   threshhold--is documented below.) By default, any event  coming  due  in  the
  193.   next 14 days will show up when the program is run.
  194.  
  195.   Dates with explicitly coded years which are in the future will,  by  default,
  196.   not show up.  If you'd like to add the next five years of specific dates  for
  197.   the family reunion in Hoboken, you can do so  and  only  the  next  one  will
  198.   potentially show up.  This can be overridden using the "/-FUTURE" parameter.
  199.  
  200.   Additionally, you can specify age thresholds on an  event-by-event  basis  by
  201.   beginning the relevant descriptions with  "/Ddays"  (for  example,  "11/01/95
  202.   /D60 BIG meeting!").  Specific age thresholds like this are not overridden by
  203.   the "/Ddays" parameter specified from the  command  line.   There  are  other
  204.   parameters  which  can  be  embedded  in  the  input  file;  see  the  "Other
  205.   event-by-event parameters" section below.
  206.  
  207.  
  208. DATES.DOC                              5                           Jul 31, 1997
  209.  
  210. How the dates are actually displayed:
  211.  
  212.   As far as the actual display of the information is concerned, each  event  is
  213.   typically presented as just "date event", where any relative  day  references
  214.   like "4TH" get resolved before the date is shown.  For example, presume  it's
  215.   May 25 in 1994, /D14 is in effect, and your  input  file  has  the  following
  216.   three lines:
  217.  
  218.         05/28/30 Mr.Fury
  219.         05/LMO/xx Memorial Day
  220.         05/31/57 Bruce Guthrie
  221.  
  222.   The initial display settings are /DATE /-DAY /-AGE /-CTDOWN.   This  presents
  223.   the information as:
  224.  
  225.         05/28/30 Mr.Fury
  226.         05/30/xx Memorial Day
  227.         05/31/57 Bruce Guthrie
  228.  
  229.   See the syntax descriptions for what each of these settings  mean.   Changing
  230.   the settings to /-DATE /DAY /AGE /CTDOWN presents it as:
  231.  
  232.         [Sat] (64th) 3 days until Mr.Fury
  233.         [Mon] 5 days until Memorial Day
  234.         [Tue] (37th) 6 days until Bruce Guthrie
  235.  
  236.   In addition, DATES.EXE allows the dates that are displayed to be in a totally
  237.   different format than those in the input file.  By default, the  output  date
  238.   format is identical to the input date format but it does not have to be.   It
  239.   can be overridden using the /ODATE=format parameter.
  240.  
  241.   The characters that can be used in the output format  include  the  following
  242.   special characters (from the VB/DOS on-line help):
  243.  
  244.         Symbol   Description
  245.         ══════   ════════════════════════════════════════════════════════
  246.         d        Display the day as a number without leading zeros (1-31)
  247.         dd       Display the day as a number with leading zeros (01-31)
  248.         ddd      Display the day as an abbreviation (Sun-Sat)
  249.         dddd     Display the day as a full name (Sunday-Saturday)
  250.         ddddd    Display a serial date number as a complete date
  251.                  (including day, month, and year)
  252.  
  253.         m        Display the month as a number without leading zeros (1-12);
  254.                  if used immediately following h or hh, the minute rather
  255.                  than the month is displayed
  256.         mm       Display the month as a number with leading zeros (01-12);
  257.                  if used immediately following h or hh, the minute rather
  258.                  than the month is displayed
  259.         mmm      Display the month as an abbreviation (Jan-Dec)
  260.         mmmm     Display the month as a full name (January-December)
  261.  
  262.         yy       Display the year as a two-digit number (00-99)
  263.         yyyy     Display the year as a four-digit number (1900-2040)
  264.  
  265.  
  266. DATES.DOC                              6                           Jul 31, 1997
  267.  
  268.   You can embed other characters in the format string as well.  If you  need  a
  269.   space character, use an underscore character instead.  For example, if  today
  270.   is September 12, 1996, the following /ODATE=format specifications  yield  the
  271.   following results:
  272.  
  273.         mm/dd/yy        09/12/96
  274.         mmm_dd,_yyyy    Sep 12, 1996
  275.  
  276.   You can add the weekday to the output either using the /DAY parameter  or  by
  277.   specifying the /ODATE=format to be something like:
  278.  
  279.         mm/dd/yy [ddd]
  280.  
  281.   The program does not actually verify your /ODATE=format specification and you
  282.   may get a run-time error if you specify it incorrectly.
  283.  
  284.  
  285. Sorting:
  286.  
  287.   Records in the input file don't have to be in any particular  order.   Unless
  288.   sorting is specified, the dates will be presented in the order they appear in
  289.   the file so putting them in chronological order makes the most sense.
  290.  
  291. Multiple input files:
  292.  
  293.   You can specify multiple date input files.  They are processed in  the  order
  294.   they are entered.  By default, each will have the  initial  date  restriction
  295.   (typically 14 days).  You can override the date restriction  for  a  specific
  296.   file by including the date restriction after the file name.  For example:
  297.  
  298.         DATES DATE1.TXT DATE2.TXT /D10 DATE3.TXT
  299.  
  300.   Given a default 14-day restriction, the date restrictions will be 14 days for
  301.   DATE1.TXT and DATE3.TXT, 10 days for DATE2.TXT.  If you want to override  the
  302.   date restriction for all files, include that date restriction before the file
  303.   name.  For example:
  304.  
  305.         DATES /D5 DATE1.TXT DATE2.TXT /D10 DATE3.TXT
  306.  
  307.   In this case, the date restriction will be 5 days for DATE1.TXT and DATE3.TXT
  308.   and 10 days for DATE2.TXT.
  309.  
  310.  
  311. DATES.DOC                              7                           Jul 31, 1997
  312.  
  313. Other event-by-event parameters:
  314.  
  315.   In addition to being able to specify "/Ddays"  on  an  event-by-event  basis,
  316.   certain command-line parameters can be embedded within the dates input  file.
  317.   See  the  discussion  about  "Syntax"  later  for  a  description  of   these
  318.   parameters. These parameters must begin in the first column of the  line  and
  319.   only one parameter can be specified on a line.  These parameters override one
  320.   or more defaults for the current input file only and can  be  set  and  reset
  321.   throughout the file.  The parameters affect the defaults for all dates  which
  322.   appear after them in the file until either another parameter  overrides  them
  323.   or the file ends.  The acceptable parameters are:
  324.  
  325.         /Ddays                  (can also be specified for an individual event)
  326.         /DATE=format
  327.         /DATE   and /-DATE
  328.         /DAY    and /-DAY       (same as /WEEKDAY and /-WEEKDAY)
  329.         /AGE    and /-AGE
  330.         /CTDOWN and /-CTDOWN
  331.         /COLOR=nnn nnn nnn nnn
  332.  
  333.   For example:
  334.  
  335.         01/01/XX A stellar new years event
  336.         /-AGE
  337.         /-DAY
  338.         01/20/92 Expect the unexpected!
  339.         01/22/94 Another one (still covered by same parameters)
  340.         /AGE
  341.         01/23/94 Skipping age on this one
  342.         /-AGE
  343.         01/25/94 And reinstating it here
  344.  
  345.   A sample United States-oriented DATES.TXT file is provided  and  consists  of
  346.   the following lines:
  347.  
  348.         01/01/xx New Year's Day
  349.         01/3MO/xx Martin Luther King's birthday
  350.         02/14/xx \000\012\000 Valentine's Day 
  351.         03/17/xx St. Patrick's Day
  352.         03/30/xx -ish Easter
  353.         04/1SU/xx Daylight Savings Time begins (add an hour)
  354.         05/2SU/xx Mother's Day
  355.         05/LMO/xx Memorial Day
  356.         05/31/57 Bruce Guthrie (WayneSof@erols.com) \000\012\000√
  357.         06/3SU/xx Father's Day
  358.         07/04/xx July 4th (\000\012\000U.S \000\015\000Independence \000\009\000Day)
  359.         09/1MO/xx Labor Day
  360.         10/LSU/xx Daylight Savings Time ends (subtract an hour)
  361.         10/31/xx Halloween
  362.         11/1TU/xx Election Day
  363.         11/11/xx Veteran's Day
  364.         11/4TH/xx Thanksgiving
  365.         12/25/xx Christmas
  366.  
  367.   (See "Embedding decimal  codes  in  the  date  files"  discussion  below  for
  368.   explanation of "\nnn" codes.)
  369.  
  370.  
  371. DATES.DOC                              8                           Jul 31, 1997
  372.  
  373. Embedding decimal codes in the date files:
  374.  
  375.   You can embed decimal codes in the data file using "\nnn" (where "nnn" is the
  376.   decimal value) or "&Hhh" (where "hh" is a hexadecimal code).  This is  mainly
  377.   used in cases where you might want to split the entry into multiple lines  by
  378.   putting in a "\013".  You're responsible for your own spacing if you use this
  379.   feature.  See the BRUCEHEX.DOC file.
  380.  
  381.   You can also use this feature to embed color commands within the text so  the
  382.   text colors change when a particular item is displayed.  This  requires  some
  383.   effort but it can be  done  by  embedding  \000\0ff\00b  in  the  text.   For
  384.   example:
  385.  
  386.         07/06/95 This is a \000\006\003multiline\000\007\004\013test
  387.  
  388.   The example above displays the item in two lines.  The first part of the line
  389.   will be in  the  default  color  (defaults  to  white  on  black),  the  word
  390.   "multiline" will be brown on cyan, and the word "test" will be  in  white  on
  391.   red.  The \nnn codes must be entered correctly or  you'll  get  unpredictable
  392.   results.  Note that this requires three  "\nnn"  parameters  each  time;  the
  393.   first is "\000" saying that the color's about to  be  reset,  the  second  is
  394.   "\0ff" and specifies the foreground  color,  and  the  third  is  "\00b"  and
  395.   specifies the background color.
  396.  
  397.   Foreground colors:
  398.  
  399.         Low intensity           High intensity
  400.  
  401.         0 = black                8 = dark grey
  402.         1 = blue                 9 = light blue
  403.         2 = green               10 = light green
  404.         3 = cyan                11 = light cyan
  405.         4 = red                 12 = light red
  406.         5 = magenta             13 = light magenta
  407.         6 = brown (or yellow)   14 = light yellow
  408.         7 = white               15 = bright white
  409.  
  410.   Adding 16 to any color will make  the  text  blink.   Background  colors  can
  411.   consist of 0 to 7 above.   Bright  white  on  blue,  for  example,  would  be
  412.   \000\015\001.
  413.  
  414.   If you wanted to, you could embed something like this in your file:
  415.  
  416.         07/04/xx July 4th \013\000\012\007▌▌\000\001\007░░\013\000\012\007▌▌▌▌
  417.  
  418.   The "▌" symbol is decimal 221 and  can  be  entered  as  Alt-221  (using  the
  419.   numeric keyboard or replaced with "\221").  Similarly, "░" is decimal 176.
  420.  
  421.   The above example would draw a (crappy) little flag on your screen.  Remember
  422.   again that you are responsible for your own line indentation for  the  second
  423.   and subsequent lines.
  424.  
  425.   Want to flag lines that are more significant than others?  Add something like
  426.   \000\012\000√ at the end of the items that are important.  This adds a bright
  427.   red on black check mark (decimal 251) to important lines.
  428.  
  429.  
  430. DATES.DOC                              9                           Jul 31, 1997
  431.  
  432. Specifying command-line parameters:
  433.  
  434. Parameters for this program can be set in the following ways.  The last setting
  435. encountered always wins:
  436.   - Read from an *.INI file (see BRUCEINI.DOC file),
  437.   - Through the use of an environmental variable (SET DATES=whatever), or
  438.   - From the command line (see "Syntax" below)
  439.  
  440.  
  441. Syntax:
  442.  
  443.     DATES [ date_file ... ] [ /Ddays ] [ /SKIP ] [ /DATE=format ]
  444.       [ /ODATE=format ] [ /-DATE ] [ /DAY ] [ /-AGE ] [ /FUTURE ] [ /CTDOWN ]
  445.       [ /SORT | /-SORT ] [ /GLOBAL | /-GLOBAL ]
  446.       [ /CLS | /-CLS ] [ /P | /Pn | /-P ] [ /W | /W0 | /-W ] [ /R ]
  447.       [ /Q | /-Q ] [ /COLOR=nnn nnn nnn | /MONO ]
  448.       [ /Iinitfile | /-I ] [ /-ENV ] [ /? ] [ /?&H ] [ > filename ]
  449.  
  450. where:
  451.  
  452. "date_file" is the name of the input text file.  It can contain drive and  path
  453. information if desired.   This  defaults  to  DATES.TXT.   If  no  filename  is
  454. specified, the program will check for it along your  DOS  path  beginning  with
  455. your default subdirectory.  Multiple  date  files  and  date  restrictions  are
  456. allowed.  See the notes above about this.  In order to allow you to specify the
  457. date_file (or files) in an *.INI file, the date_file name can  be  preceded  by
  458. "/C".  For example, "/CC:\BAT\DATEMINE.TXT".
  459.  
  460. "/Ddays" (or "days") are the number of days in advance you  want  the  warning.
  461. Initially defaults to /D14.  Generic days ("11/xx/xx") are not affected by this
  462. setting; you automatically get the notice 15 days before the beginning  of  the
  463. month and through the entire month itself.  Events coded with specific "/Ddays"
  464. entries are also not affected by the command-line "/Ddays" setting.
  465.  
  466. "/SKIP" says to print a message (unless /Q is specified) but  otherwise  ignore
  467. it if one or more of the date input files is not found.
  468.  
  469. "/-SKIP" says to abort if any of the input files are not found.
  470.  
  471. "/DATE=format" specifies the format that the input dates are to have.  The date
  472. must consist of pairs of "mm" (month), "dd" (day), and "yy"  (year)  characters
  473. in any order.  A single consistent  delimiter  character--either  slash  ("/"),
  474. dash ("-"), or period (".")-- should be used around the  pairs  of  characters.
  475. Examples, /DATE=mm/dd/yy and /DATE=dd-mm-yy.  Note that  the  format  does  not
  476. restrict you to have two-character date items; it is mainly  used  to  identify
  477. the delimiter between items as well as the order in which the month,  day,  and
  478. year  items  appear.   Four-digit  years,  spelled  out  months,  etc  are  all
  479. acceptable.
  480.  
  481. "/ODATE=format" specifies the format that the output date is to have. Initially
  482. defaults  to  the  /DATE=format  specification  but  the  /ODATE=format  offers
  483. considerably more format options than the input format  allows  for.   See  the
  484. section on "How the dates are actually displayed" above for more details  about
  485. options in the format.
  486.  
  487.  
  488. DATES.DOC                              10                          Jul 31, 1997
  489.  
  490. "/DATE" indicates that the date is to be presented if the entry is  show.  This
  491. is initially the default.
  492.  
  493. "/-DATE" skips showing the date of the event when it's displayed.
  494.  
  495. "/DAY" (or "/WEEKDAY") shows the day of the week for each event if possible.
  496.  
  497. "/-DAY" (or "/-WEEKDAY") skips showing the day of the week.  This is  initially
  498. the default.
  499.  
  500. "/AGE" shows the age of the event when it's displayed.  This is only  done  for
  501. entries that have a specific year.  This is initially the default.
  502.  
  503. "/-AGE" skips showing the age of the event.
  504.  
  505. "/FUTURE" says to include dates which occur in future  years  outside  of  your
  506. date range.  For example, if it's currently June 5, 1996, "/FUTURE" will  allow
  507. an event scheduled for June 5, 1997 to show up; otherwise, it won't.  Initially
  508. defaults to "/-FUTURE".
  509.  
  510. "/-FUTURE" says that dates which occur in future years will not show up.   This
  511. allows you to pre-load your file with major upcoming dates into the far  future
  512. (family reunions for the rest of eternity, for example).  This is initially the
  513. default.
  514.  
  515. "/CTDOWN" adds a "x days until" message in front of any displayed event.
  516.  
  517. "/-CTDOWN" skips adding the "x days until"  message.   This  is  initially  the
  518. default.
  519.  
  520. "/SORT" sorts the entries by their date difference (the number of days  between
  521. now and the date of the event).  If you're using more than one dates file  with
  522. the "/-GLOBAL" (default) parameter, all appropriate entries from a given  dates
  523. file will be sorted and displayed before any entries from the next  dates  file
  524. are displayed.  The "/GLOBAL" parameter will combine them  all  before  sorting
  525. them.  Using "/SORT" precludes you from showing  any  display  comments  (lines
  526. beginning with "*") in  your  file.   Currently,  the  program  limits  you  to
  527. displaying 100 items per input file if /SORT is specified; let me know if  this
  528. limit is too low for you.
  529.  
  530. "/-SORT" says to display the entries as they're found in the  files.   This  is
  531. initially the default.
  532.  
  533. "/GLOBAL" invokes "/SORT" and  merges  multiple  date  input  files  if  found,
  534. sorting them as a unit instead of individually.
  535.  
  536. "/-GLOBAL" treats each date input file as a unique entity for sorting purposes.
  537. This is initially the default.
  538.  
  539. "/CLS" clears the display before showing the results.
  540.  
  541. "/-CLS" does not clear the display first.  This is the default.
  542.  
  543.  
  544. DATES.DOC                              11                          Jul 31, 1997
  545.  
  546. "/P" says to pause the output every 23 lines.  (NOTE:  The  /P,  /Pn,  and  /-P
  547. options affect pausing while listing events; the /W, /W0,  /-W  options  affect
  548. pausing after the program finishes.)
  549.  
  550. "/Pn" says to pause the output every n-number of lines.
  551.  
  552. "/-P" says to not pause the output at all.  This is initially the default.
  553.  
  554. "/W" says to pause with a "Press any key to continue" message after the program
  555. finishes if any hits were found.  This parameter is ignored if redirection  out
  556. is being used.
  557.  
  558. "/W0" says to pause afterward whether any hits were  found  or  not.   This  is
  559. initially the default if the program is  run  under  Windows3.1  or  Windows95.
  560. DATES won't detect if you're running under Windows NT though; you can  manually
  561. specify this parameter if the window closes up on you before you can  read  the
  562. results.  This parameter is ignored if redirection out is being used.
  563.  
  564. "/-W" says to not pause afterward at all.  This is initially the default if the
  565. program is run under DOS or Windows NT.
  566.  
  567. "/R" sets a DOS return code equal to the number of dates found.   The  standard
  568. way to use something like this is with a test  on  the  DOS  ERRORLEVEL  in  an
  569. AUTOEXEC.BAT file or something.  For example:
  570.  
  571.        DATES /R
  572.        IF ERRORLEVEL 1 GOTO HITS
  573.        GOTO END
  574.        :HITS
  575.        PAUSE
  576.        :END
  577.        ECHO DONE
  578.  
  579. Note that the results of particular example could have been done  easier  using
  580. DATES' /W parameter.
  581.  
  582. "/Q" stops the printing every message except for the actual date  lines.   This
  583. option is automatically invoked if redirection is used.
  584.  
  585. "/-Q" turns back on  the  printing  of  almost  every  message.   This  is  the
  586. initially default unless redirection is used.
  587.  
  588.  
  589. DATES.DOC                              12                          Jul 31, 1997
  590.  
  591. "/COLOR=nnn nnn nnn" specifies the color settings to use for (in order) regular
  592. text, dates happening today, and the ages of dates happening today.  Any  input
  593. lines which begin with an asterisk are printed using the third color set.  Each
  594. setting must consist of three digits, the first two being the foreground  color
  595. and the last being the background color.  The foreground color should be padded
  596. on the left with a 0 if it is only one digit in length.  Defaults to "COLOR=070
  597. 150 090" (white on black, bright white on black, and bright blue on black).
  598.  
  599. Foreground colors:
  600.  
  601.         Low intensity           High intensity
  602.  
  603.         0 = black                8 = dark grey
  604.         1 = blue                 9 = light blue
  605.         2 = green               10 = light green
  606.         3 = cyan                11 = light cyan
  607.         4 = red                 12 = light red
  608.         5 = magenta             13 = light magenta
  609.         6 = brown (or yellow)   14 = light yellow
  610.         7 = white               15 = bright white
  611.  
  612. Adding 16 to any color will make the text blink.  Background colors can consist
  613. of 0 to 7 above.  Bright white on blue, for example, would be "151".
  614.  
  615. "/MONO"  (or  "/-COLOR")  suppresses  all  screen  color  settings.   Initially
  616. defaults to "/COLOR".
  617.  
  618. "/COLOR" (or "/-MONO") allows  screen  color  settings  and  is  initially  the
  619. default.
  620.  
  621. "/Iinitfile" says to read an initialization file with the file name "initfile".
  622. The file specification *must* contain a period.  Initfiles are described in the
  623. BRUCEINI.DOC file.  Initially defaults to "/IDATES.INI".
  624.  
  625. "/-I" (or "/INULL") says to skip loading the initialization file.
  626.  
  627. "/ENV" says to look for %var% occurrences  in  the  command  line  and  try  to
  628. resolve any apparent environmental variable references.  See  BRUCEINI.DOC  for
  629. more information.  This is initially the default.
  630.  
  631. "/-ENV" says to skip resolving apparent %var% occurrences in the command  line.
  632. Initially defaults to "/ENV".
  633.  
  634. "/?" or "/HELP" or "HELP" shows you the syntax for the command.
  635.  
  636. "/?&H" gives you a hexadecimal and decimal conversion table.
  637.  
  638. "> filename" redirects the  output  to  a  DOS  file.   This  is  standard  DOS
  639. redirection.  Automatically invokes /Q option and turns off  the  last  of  the
  640. status messages.
  641.  
  642.  
  643.  
  644. DATES.DOC                              13                          Jul 31, 1997
  645.  
  646. Return codes:
  647.  
  648. DATES returns the following ERRORLEVEL codes:
  649.       255 = syntax problems, or /? requested
  650.  
  651. If /R is specified, the ERRORLEVEL code will be the number of hits found.
  652.  
  653.  
  654. Author:
  655.  
  656. This program was written by Bruce Guthrie of Wayne Software.  It  is  free  for
  657. use and  redistribution  provided  relevant  documentation  is  kept  with  the
  658. program, no changes are made to the program or documentation,  and  it  is  not
  659. bundled with commercial programs or charged for separately.  People who need to
  660. bundle it in for-sale packages must  pay  a  $50  registration  fee  to  "Wayne
  661. Software" at the following address.
  662.  
  663. Additional information about this and other  Wayne  Software  programs  can  be
  664. found in the file BRUCE.DOC which should be included in the original ZIP  file.
  665. The recent change history for this and the other programs is  provided  in  the
  666. HISTORY.ymm file which should be in the same ZIP file where "y" is replaced  by
  667. the last digit of the year and "mm" is the two  digit  month  of  the  release;
  668. HISTORY.611 came out in November 1996.  This same naming convention is used  in
  669. naming the ZIP file (DATESymm.ZIP) that this program was included in.
  670.  
  671. Comments and suggestions can also be sent to:
  672.  
  673.                 Bruce Guthrie
  674.                 Wayne Software
  675.                 113 Sheffield St.
  676.                 Silver Spring, MD 20910
  677.  
  678.                 e-mail: WayneSof@erols.com   fax: (301) 588-8986
  679.                 http://www.geocities.com/SiliconValley/Lakes/2414
  680.  
  681. Please provide an Internet e-mail address on all correspondence.
  682.  
  683. 
  684.